Retrieve detailed information about instances using Monitor ID

GET 
/query/objects/:id/instances

Call this API to obtain detailed information for each monitor instance.

Request

Path Parameters

id integerrequired

Unique identifier for the monitor. This Monitor ID is required to fetch detailed information about the corresponding monitor instances. "

Responses

200

The request was successful, and the server has returned the requested monitor instance details. The response contains a JSON object with the monitor instance information.

application/json

Schema

Schema

result object[]
Array [
status string
interface string
interface.name string
interface.index string
interface.address string
interface.description string
interface.type string
interface.bit.type string
interface.speed.bytes.per.sec integer
]

Example (from schema)

{
  "result": [
    {
      "status": "up",
      "interface": "g21-21",
      "interface.name": "g22",
      "interface.index": "22",
      "interface.address": "38:94:ed:1f:f6:d7",
      "interface.description": "Slot: 0 Port: 22 Gigabit - Level",
      "interface.type": "ethernetCsmacd (6)",
      "interface.bit.type": "1",
      "interface.speed.bytes.per.sec": 0
    }
  ]
}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

The server understood the request, but the client does not have the necessary permissions to access the resource.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

The server encountered an unexpected condition that prevented it from fulfilling the request. This is a generic error message indicating an internal server error.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...